blog.ly (1.0.0)

Download OpenAPI specification:Download

This is the API documentation for blog.ly.

Authentication

blog.ly supports authentication with OAuth2.0.

blog

Operations on blogs

Get a list of blogs

query Parameters
author
integer

Fetch blogs by author uuid.

cursor
string

Cursor token for paging the blogs returned.

limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of results to return in a page.

Responses

Response samples

Content type
application/json
[
  • 0
]

Create a new blog

This can only be done by users who have logged in.

Responses

Response samples

Content type
application/json
0

Get blog details

path Parameters
uuid
required
integer

Blog uuid.

Responses

Response samples

Content type
application/json
{
  • "uuid": 0,
  • "title": "string",
  • "contents": "string",
  • "rendered": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "author": 0,
  • "authorName": "string"
}

Update an existing blog

This can only be done by users who have logged in and on blogs that the user has authored.

path Parameters
uuid
required
integer

Blog uuid.

Request Body schema: application/json

New blog contents

title
string

Blog title

contents
string

Blog contents in raw Markdown

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "contents": "string"
}

Delete an existing blog

This can only be done by users who have logged in and on blogs that the user has authored.

path Parameters
uuid
required
integer

Blog uuid.

Responses

user

Operations on users

Get user information

query Parameters
user
required
integer

User uuid.

Responses

Response samples

Content type
application/json
{
  • "uuid": 0,
  • "username": "string",
  • "name": "string",
  • "description": "string",
  • "notificationPreference": "string"
}

Update user information

This can only be done by users who have logged in.

Request Body schema: application/json

New user information

name
string

User name

description
string

User description ("About Me")

notificationPreference
string

Notification preference (TBD)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "notificationPreference": "string"
}

follow

Add a follow entry

This can only be done by users who have logged in.

query Parameters
user
required
integer

User uuid.

Responses

Delete a follow entry

This can only be done by users who have logged in.

query Parameters
user
required
integer

User uuid.

Responses

search

Operations on searching for blogs

Search for blogs

query Parameters
keyword
required
string

Keyword(s) to search for

cursor
string

Cursor token for paging the blogs returned.

limit
integer [ 1 .. 100 ]
Default: 10

Maximum number of results to return in a page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

The User Model

uuid
integer

User uuid

username
string >= 4 characters

User username

name
string

User name

description
string

User description ("About Me")

notificationPreference
string

Notification preference (TBD)

{
  • "uuid": 0,
  • "username": "string",
  • "name": "string",
  • "description": "string",
  • "notificationPreference": "string"
}

The Blog Model

uuid
integer

Blog uuid

title
string

Blog title

contents
string

Blog contents in raw Markdown

rendered
string

Blog contents in rendered HTML

created
string <date-time>

Blog creation datetime

updated
string <date-time>

Blog last updated datetime

author
integer

Blog author uuid

authorName
string

Blog author name

{
  • "uuid": 0,
  • "title": "string",
  • "contents": "string",
  • "rendered": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "author": 0,
  • "authorName": "string"
}

The Search Result Model

blog
integer

Blog uuid

author
integer

Author uuid

hits
integer

Total hits

{
  • "blog": 0,
  • "author": 0,
  • "hits": 0
}